Add extra link check to release.md #613
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
trask
approved these changes
Dec 17, 2024
RELEASING.md
Outdated
| @@ -2,6 +2,9 @@ | |||
|
|
|||
| _Instruction for Maintainers only._ | |||
|
|
|||
| - Run [opentelemetry.io workflow](https://github.com/open-telemetry/opentelemetry.io/actions/workflows/build-dev.yml) | |||
There was a problem hiding this comment.
How do you run this against a submodule? Can you please provide more details. I don't know how to do this.
There was a problem hiding this comment.
- open that link
- type opentelemetry-proto into the submodule field
- Run it
- wait for it to complete
- Both
BUILD and CHECK LINKSandWARNINGS in build log?should pass. - If any of them fails, check
BUILD and CHECK LINKS/Run npm run log:test-and-fixlogs - broken links should be there - Ignore
REFCACHE updates?status.
Did I capture it right @chalin ?
run with broken links
run without issues:
I don't think we normally go into this level of details in release doc so I don't think we should update it, it's easy to figure out the moment you try it.
There was a problem hiding this comment.
Great, thanks! Would it be possible to add the distilled version of this to RELEASING.md?
chalin
reviewed
Dec 17, 2024
RELEASING.md
Outdated
| @@ -2,6 +2,9 @@ | |||
|
|
|||
| _Instruction for Maintainers only._ | |||
|
|
|||
| - Run [opentelemetry.io workflow](https://github.com/open-telemetry/opentelemetry.io/actions/workflows/build-dev.yml) | |||
Co-authored-by: Patrice Chalin <[email protected]>
|
I'm going to close it in favor of #614 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See open-telemetry/semantic-conventions#1009 and #611 (comment) for the context.
TL;DR: markdown-link-check does not check cross-file anchor links.
Today broken links are discovered only when a new proto release is published on otel.io, where these links needs to be manually overridden and fixed.
The general tooling for this is tracked in open-telemetry/semantic-conventions#1009, in the meantime, we should leverage otel.io workflow that can run against proto
mainbranch and detect broken anchors.It finds a few broken anchors in almost every semconv and spec release, so 1) it's useful 2) it adds just a few minutes to the release process and not too bad.
This PR adds this as a manual step until we have a full automation.